Model Attribute Description

The HL7 attribute classCode uses a code to describe this class as a clinical document.

Implementation in XML Instance

The XML attribute classCode is fixed to " DOCCLIN".

Model Attribute Description

The HL7 attribute confidentialitycode uses a code from any vocabulary to describe the confidentiality of the CDA document. This may be implemented using NHS CFH sealing or some form of locally agreed access control.

Implementation in XML Instance

When implementing NHS CFH Sealing then:

A code from the HL7 x_BasicConfidentialityKind vocabulary to denote the level of confidentially applied to the document.

The Coded Plain flavour of the Coded Value (CV) data type shall be used to carry this information in the XML element confidentialityCode as follows:

• The XML attribute code shall contain a fixed value of "V".
• The XML attribute codeSystem shall contain the OID of "2.16.840.1.113883.1.11.16926".
• The XML attribute displayName shall carry a value of "very restricted".

When this attribute contains a value of "V" ("very restricted") then the relevant centralised ACF service must be consulted prior to rendering to any user.

Otherwise it shall be populated with:

Either

A code from the HL7 x_BasicConfidentialityKind vocabulary to denote the level of confidentially applied to the document.

The Coded Plain flavour of the Coded Value (CV) data type shall be used to carry this information in the XML element confidentialityCode as follows:

• The XML attribute code shall contain a value from the stated HL7 vocabulary.
• The XML attribute codeSystem shall contain the OID of "2.16.840.1.113883.1.11.16926".
• The XML attribute displayName shall carry the description associated with the code.

These codes should be populated and processed as appropriate for the local requirement for controlling access to the information.

Or

A code from an alternative locally agreed vocabulary to denote the level of confidentially applied to the document.

The Coded Plain flavour of the Coded Value (CV) data type shall be used to carry this information in the XML element confidentialityCode as follows:

• The XML attribute code shall contain a value from the vocabulary.
• The XML attribute codeSystem shall contain the OID "2.16.840.1.113883.2.1.3.2.4.17.415"
• The XML attribute displayName shall carry a value associated with the code.

These codes should be populated and processed as appropriate for the local requirement for controlling access to the information.

Model Attribute Description

The HL7 attribute effectiveTime is used to define the creation time of the CDA document.

Implementation in XML Instance

The XML attribute value of the XML element effectiveTime shall be populated with the time the document was created using a time stamp in the format yyyymmddhhmmss[+|-ZZzz] where:

• yyyy is the year
• mm is the month
• dd is the day
• hh is the hour
• mm is the minutes
• ss is the seconds
• [+|-ZZzz] is the time zone offset in hours and minutes

Sections from the right of this representation may be left off when the sending system does not record to this level of accuracy. When hours are present, the time zone offset must also be present.

Model Attribute Description

The HL7 (NHS localisation) attribute messageType identifies the CDA document as one that complies with a certain NHS CDA profile.

The value of this attribute provides a unique identifier for the profile in question.

Implementation in XML Instance

The XML element messageType is populated as follows

• The XML attribute root shall carry the OID "2.16.840.1.113883.2.1.3.2.4.18.17"
• The XML attribute extension shall carry the value "POCD_MT010011GB02"

Model Attribute Description

Model Attribute Description

The HL7 attribute title uses a string which is rendered as a human readable title.

Implementation in XML Instance

The XML element title is populated as follows:

When using a single code in the XML attribute code of the XML element code the XML element title shall contain either:

• The description associated with the code carried in the XML attribute code of the XML element code

or

• A human readable string deemed to be the title of the document by the sending system.
  

When using multiple SNOMED CT codes in the XML attribute code of the XML element code the XML element title shall contain:

• A human readable string deemed to be the title of the document by the sending system. This string may be derived from the multiple SNOMED CT code preferred terms.

Note: the term sending system is used here as a generic term, how the title is defined is dependant system configuration or design.

Model Attribute Description

The HL7 attribute versionNumber uses an integer value to allow versioning of the CDA document.

The version number here is the version number of this document

Implementation in XML Instance

The XML element versionNumber is populated as follows:

• The XML attribute value should contain the version number of the document as an integer value.

This class is a participation of authentication. It is used for participations where the CDA document needs to be authenticated. This means that the person who authenticated will have overall responsibility for the document not the author. For example a supervisor.

Model Attribute Description

The HL7 attribute typeCode uses a code to describe this class as an authenticator participation.

Implementation in XML Instance

The XML attribute classCode is fixed to " AUTHEN".

Model Attribute Description

The HL7 attribute signatureCode uses a code to describe signature for the CDA document.

This attribute is currently not used for NHS CDA implementations and should be nulled.

Implementation in XML Instance

The XML attribute nullFlavor of the XML element signatureCode shall contain the value " NA"

Model Attribute Description

The HL7 attribute authenticator time is used to indicate when the person authenticated the CDA document.

Implementation in XML Instance

The XML attribute value of the XML element time, shall be populated with a time stamp in the format yyyymmddhhmmss[+|-ZZzz] where:

• yyyy is the year
• mm is the month
• dd is the day
• hh is the hour
• mm is the minutes
• ss is the seconds
• [+|-ZZzz] is the time zone offset in hours and minutes

Sections from the right of this representation may be left off to when the sending system does not record to this accuracy. When hours are present, the time zone offset must also be present.

When the time of authentication is not available to the sending system then:

• The XML attribute nullFlavor of the XML element time shall contain the value "NI"

A link to a choice of authenticator templates.

This class is a participant of authorship. It holds details of how and when the author authored the CDA document.

Model Attribute Description

The HL7 attribute author time is used to indicate when the person authored the CDA document.

Implementation in XML Instance

The XML attribute value of the XML element time, shall be populated with a time stamp in the format yyyymmddhhmmss[+|-ZZzz] where:

• yyyy is the year
• mm is the month
• dd is the day
• hh is the hour
• mm is the minutes
• ss is the seconds
• [+|-ZZzz] is the time zone offset in hours and minutes

Sections from the right of this representation may be left off to when the sending system does not record to this accuracy. When hours are present, the time zone offset must also be present.

A link to the choice of author templates.

Details of the authorisation associated with the CDA document

Model Attribute Description

The HL7 attribute typeCode uses a code to describe this class as one of authorization.

Implementation in XML Instance

The XML attribute typeCode is fixed to " AUTH".

A link to details of the consent associated with the CDA document.

This class is a component that connects the document header to the structured body.

Model Attribute Description

The HL7 attribute typeCode uses a code to describe this class as a component.

Implementation in XML Instance

The XML attribute typeCode is fixed to " COMP".

A link to the choice of document bodies.

This class is a component of relationship it is used to link the document header to the EncompassingEncounter that the CDA document is documenting.

Model Attribute Description

The HL7 attribute typeCode uses a code to describe this class as a component.

Implementation in XML Instance

The XML attribute typeCode is fixed to " COMP".

A link to the Encompassing encounter.

A class which is a participation of custodian.

The custodian is the legal owner of the CDA document and is the organisation responsible for maintaining the information in the CDA document.

Model Attribute Description

The HL7 attribute typeCode uses a code to describe this class as a custodian participation.

Implementation in XML Instance

The XML attribute classCode is fixed to " CST".

A link to the custodian templates.

This class is a data enterer participation.

A data enterer is the person who entered the information contained in the document.

Model Attribute Description

The HL7 attribute typeCode uses a code to describe this participation as a data enterer.

Implementation in XML Instance

The XML attribute typeCode is fixed to " ENT".

Model Attribute Description

The HL7 attribute contextConductionCode uses a set of codes from the HL7 vocabulary ContextControl to determine whether participations associated with the parent section is conducted across to the child section (also associated with the child section). This set of codes also determine how these participations conduct.

The conduction can only take place if the contextConductionInd is set to "true".

The value of this attribute is fixed in the HL7 model to "OP":

• "O" (Overriding)- the data enterer replaces any data enterer that has been conducted from any previous acts.
• "P" (Propagating)- the data enterer is conducted to all child acts where the contextConductionInd is set to "true".

Implementation in XML Instance

The XML attribute contextControlCode shall contain the value " OP".

A link to the choice of data enterer templates.

This class is a documentation of relationship. It is used to link the document header to the Service Event being documented in the CDA document.

Model Attribute Description

The HL7 attribute classCode uses a code to describe this class as a document class.

Implementation in XML Instance

The XML attribute classCode is fixed to " DOC".

A link to the service event.

A class which is a participation of informant.

An informant is a person who informed the author about information contained in the CDA document.

Model Attribute Description

The HL7 attribute typeCode uses a code to describe this class as an informant participation.

Implementation in XML Instance

The XML attribute classCode is fixed to " INF".

Model Attribute Description

The HL7 attribute contextConductionCode uses a set of codes from the HL7 vocabulary ContextControl to determine whether participations associated with the parent section is conducted across to the child section (also associated with the child section). This set of codes also determine how these participations conduct.

The conduction can only take place if the contextConductionInd is set to "true".

The value of this attribute is fixed in the HL7 model to "OP":

• "O" (Overriding)- the custodian replaces any custodian that has been conducted from any previous acts.
• "P" (Propagating)- the custodian is conducted to all child acts where the contextConductionInd is set to "true".

Implementation in XML Instance

The XML attribute contextControlCode shall contain the value " OP".

A link to the choice of informant templates.

This class is a primary information recipient participation.

The primary information recipients of the clinical documents are usually expected to perform some action on receipt of a CDA document. There can be more than one primary recipient.

Model Attribute Description

The HL7 attribute typeCode uses a code to describe this class as a primary information recipient participation.

Implementation in XML Instance

The XML attribute classCode is fixed to " PRCP".

A link to the choice of primary information recipient templates.

A class which is for all other participants associated with the CDA document not covered by a participation specifically modelled.

Participants are people,organisations or devices that are involved in some way with the CDA document.

Model Attribute Description

The HL7 attribute typeCode uses a code from the HL7 vocabulary ParticipationType to identify the type of participation.

Implementation in XML Instance

The XML attribute typeCode shall contain a code from the HL7 vocabulary ParticipationType, The recommended codes to use for NHS use are listed below:

Code	Display name	Definition
BBY	baby	A baby is a type of direct target that represents the participation of a baby (or foetus), this may be used when the mother is the patient and it is required to identify the baby or babies.
CALLBCK	call back contact	A person or organisation who should be specifically contacted for follow-up questions about the document when it is not the author.
CON	consultant	A consultant is a type of ancillary participation that represents an advisor participating by performing evaluations and making recommendations.
DEV	device	A device is a type of direct target that represents something used in delivering the service without being substantially affected by the act. This may be used when it is required to identify a device involved in the creation of the CDA document but when there is a human author.
DIST	distributor	A distributor is a type of performer that distributes material used in or generated during the act. This may be used when the CDA document is distributed by a third party who/ which not involved in it in any other way.
ELOC	entry location	A location when information constrained in the CDA document was entered.
NOT	urgent notification	An information recipient to notify about urgent matter associated with the CDA document
VIA	via	This may be used to indicate that the CDA document came via a third party
REFB	Referred by	A Referred by is a type of information recipient that represents the party that referred the subject of the act (e.g. patient).
REFT	Referred to	A Referred to is a type of information recipient that receives the a referral about a patient.
WIT	witness	This may be used to detail a person who witnessed service events detailed in the document

Model Attribute Description

The HL7 attribute contextConductionCode uses a set of codes from the HL7 vocabulary ContextControl to determine whether participations associated with the parent section is conducted across to the child section (also associated with the child section). This set of codes also determine how these participations conduct.

The conduction can only take place if the contextConductionInd is set to "true".

The value of this attribute is fixed in the HL7 model to "OP":

• "O" (Overriding)- the participation replaces any that has been conducted from any previous acts.
• "P" (Propagating)- the participation is conducted to all child acts where the contextConductionInd is set to "true".

Implementation in XML Instance

The XML attribute contextControlCode shall contain the value " OP".

Model Attribute Description

The HL7 attribute functionCode uses a code from the HL7 vocabulary ParticipationFunction or an alternative vocabulary to describe the function of the participant.

Implementation in XML Instance

The Coded Plain flavour of Coded with Equivalents (CE) data type shall be used to carry this information in the XML element functionCode as follows:

• The XML attribute code shall contain a code for the HL7 vocabulary ParticipationFunction
• The XML attribute codeSystem shall contain the OID "2.16.840.1.113883.5.88"
• The XML attribute displayName shall contain a description associated with the code.

The recommended values for functionCode for NHS USE are listed below:

Code	Display name	Definition
ADMPHYS	admitting physician	A physician who admitted a patient to a hospital or other care unit that is the context of this service.
ANEST	anaesthetist	In a typical anaesthesia setting an anaesthesiologist or anaesthesia resident in charge of the anaesthesia and life support, but only a witness to the surgical procedure itself. To clarify responsibilities anaesthesia should always be represented as a separate service related to the surgery.
ANRS	anaesthesia nurse	In a typical anaesthesia setting the nurse principally assisting the anaesthesiologist during the critical periods.
ATTPHYS	attending physician	A physician who is primarily responsible for a patient during the hospitalization, which is the context of the service.
DISPHYS	discharging physician	A physician who discharged a patient from a hospital or other care unit that is the context of this service.
FASST	first assistant surgeon	In a typical surgery setting the assistant facing the primary surgeon. The first assistant performs parts of the operation and assists in others (e.g., incision, approach, electrocoutering, ligatures, sutures).
MDWF	midwife	A person (usually female) helping a woman deliver a baby. Responsibilities vary locally, ranging from a mere optional assistant to a full required participant, responsible for (normal) births and pre- and post-natal care for both mother and baby.
NASST	nurse assistant	In a typical surgery setting the non-sterile nurse handles material supply from the stock, forwards specimen to pathology, and helps with other non-sterile tasks (e.g., phone calls, etc.).
PCP	primary care physician	The healthcare provider that holds primary responsibility for the overall care of a patient.
PRISURG	primary surgeon	In a typical surgery setting the primary performing surgeon.
RNDPHYS	rounding physician	A physician who made rounds on a patient in a hospital or other care center.
SASST	second assistant surgeon	In a typical surgery setting the assistant who primarily holds the hooks.
SNRS	scrub nurse	In a typical surgery setting the nurse in charge of the instrumentation.
TASST	third assistant	In a typical surgery setting there is rarely a third assistant (e.g., in some Hip operations the third assistant postures the affected leg).
AUCG	caregiver information receiver	Caregiver authorized to receive patient health information.
AULR	legitimate relationship information receiver	Provider with legitimate relationship authorized to receive patient health information.
AUTM	care team information receiver	Description: Member of care team authorized to receive patient health information.
AUWA	work area information receiver	Entities within specified work area authorized to receive patient health information.

A link to the choice of participant templates.

A class which is a participation of record target (The patient whose record is the target for the information in the Document.)

Model Attribute Description

The HL7 attribute typeCode uses a code to describe this class as a record target participation.

Implementation in XML Instance

The XML attribute classCode is fixed to " RCT".

A link to the patient role templates.

This class is a related document relationship it links the current document to a related CDA document.

Model Attribute Description

The HL7 attribute typeCode uses a code to describe the type of related document relationship.

• If the typeCode is "APND" then the current document is an addendum to the related document
• If the typeCode is "RPLC" then the current document is a replacement for the related document
• If the typeCode is "XFRM" then the current document is a transformation of the related document

A conformant CDA document can have a single relatedDocument with typeCode "APND"; a single relatedDocument with typeCode "RPLC"; a single relatedDocument with typeCode "XFRM"; a combination of two relatedDocuments with typeCodes "XFRM" and "RPLC"; or a combination of two relatedDocuments with typeCodes "XFRM" and "APND". No other combinations are allowed.

Implementation in XML Instance

The XML attribute typeCode is populated with a value from the HL7 vocabulary x_ActRelationshipDocument to describe the type of related document based on the rules stated above.

A link to the parent document.

This class is a tracker participation. A tracker is a recipient who is sent a copy of the CDA document for information only. They are not normally required to carry out any action on recipient of the CDA document.

Model Attribute Description

The HL7 attribute typeCode uses a code to describe this participation as a tracker.

Implementation in XML Instance

The XML attribute typeCode is fixed to " TRC".

A link to the choice of tracker templates.

A link to the templates for consent.

A link to the choice of participant templates.

A link to templates for a custodian.

A link to templates for an informant.

A link to the choice of patient templates.

A link to the choice of templates for an author.

A link to the choice of templates for an authenticator.

A link to the templates of a recipient.

A body using CDA structured text (mark up).

A body using a non XML body (formats other than CDA structured text).

This class is a component of a section (a section the nests within another section).

Model Attribute Description

The HL7 attribute typeCode uses a code to describe this class as a component.

Implementation in XML Instance

The XML attribute typeCode is fixed to " COMP".

Model Attribute Description

The HL7 attribute contextConductionInd uses a Boolean value (true or false) to determine whether information associated with the parent section is conducted across to the child section (also associated with the child section).

Implementation in XML Instance

The XML attribute contextConductionInd is fixed to " true".

A link to the classification section.

Model Attribute Description

Model Attribute Description

The HL7 attribute id uses an identifier to identify each instance of a classification section.

Implementation in XML Instance

The Identifier Global data type flavour is used to carry the identifier in the XML element id as follows:

• The XML attribute root shall contain a DCE UUID.

This class is a component. It links the classification section to the text sections.

Model Attribute Description

The HL7 attribute typeCode uses a code to describe this class as a component.

Implementation in XML Instance

The XML attribute typeCode is fixed to " COMP".

Model Attribute Description

The HL7 attribute contextConductionInd uses a Boolean value (true or false) to determine whether information associated with the parent section is conducted across to the child section (also associated with the child section).

Implementation in XML Instance

The XML attribute contextConductionInd is fixed to " true".

A link to the choice of section templates.

This class is an entry.

It links the classification section to the component coded entries.

Model Attribute Description

The HL7 attribute typeCode uses a code to describe this class as a component.

Implementation in XML Instance

The XML attribute typeCode is fixed to " COMP".

Model Attribute Description

The HL7 attribute contextConductionInd uses a Boolean value (true or false) to determine whether information associated with the parent section is conducted across to the child section (also associated with the child section).

Implementation in XML Instance

The XML attribute contextConductionInd is fixed to " true".

Model Attribute Description

The HL7 (NHS localisation) attribute contentId, when valued in an instance, provides a unique forward pointing identifier for the template which constrains the classes and attributes which follow, for NHS use.

The attribute is intended simply as a structural navigational aid and should not be relied upon as an indicator of semantic meaning. The contentId is populated at runtime with a value from the allowed list contained in the model.

Implementation in XML Instance

The Identifier External data type flavour is used to carry this information in the XML element contentId as follows:

• The XML attribute root is fixed to the OID "2.16.840.1.113883.2.1.3.2.4.18.16"
• The XML attribute extension shall contain one of the allowed template artefact identifiers.

A link to the coded entry.

A link to the choice of section templates.

A link to the templates for a coded entry.

Model Attribute Description

The HL7 attribute classCode uses a code to describe this class as a document body.

Implementation in XML Instance

The XML attribute classCode is fixed to " DOCBODY".

Model Attribute Description

The HL7 attribute text is used for the information which makes up the document body when the standard CDA structure (mark-up) is not used.

Implementation in XML Instance

The XML element text is populated as follows:

• The XML element text shall contain the non CDA structured text body.
• The XML attribute mediaType of the XML element text shall contain a value to identify the mime type.
• The XML attribute representation of the XML element text shall contain a value to identify the representation of the non CDA structured body.

A link to templates for a data enterer.

A link to the templates for an encompassing encounter.

Model Attribute Description

The HL7 attribute text is used to describe the MIME type of the parent document.

This attribute is used only to express the MIME type of the parent document, it is not to be used to embed the related document.

Implementation in XML Instance

The XML attribute mediaType of the XML element text shall contain the MIME type.

A link to choice of service event templates.